JS - Commentaar
Er zijn allerlei meningen over het gebruik en de inhoud van commentaar in softwareprojecten. In The Elements of Programming Style van Brian W. Kernighan en P. J. Plauger wordt gesteld: "Becommentarieer geen slechte code - herschrijf het.". In Code Complete stelt Steve McConnell: "Goed commentaar is geen herhaling of uitleg van de code. Het verduidelijkt de intentie. Commentaar dient op een hoger abstractieniveau dan de code uit te leggen wat je probeert te doen.".
De achterliggende visie is dat de code zo duidelijk dient te zijn dat een toelichting in commentaar niet nodig is.[2] Het uitleggen van de code in commentaar kan een teken zijn dat de code te complex is. Commentaar kan wel nodig zijn om uit te leggen waarom een bepaald stuk code niet voldoet aan standaarden of aan de gangbare manier om een probleem op te lossen. (Wikipedia)
In JavaScript heb je twee mogelijkheden:
- wanneer de commentaar past op de huidige regel past, plaats je voor het commentaar twee schuine strepen (//); als het commentaar niet op de huidige regel past, kun je van deze mogelijkheid alleen gebruik maken, als je het commentaar opsplists in meerdere lijnen, telkens voorafgegaan door twee schuine strepen;
- wanneer het commentaar doorloopt over meerdere regels, laat je het vooraf gaan door een slash gevolgd door een asterisk (/*) en eindigen met een asterisk gevolgd door een slash (*/);
// This is a single-line comment /* But this is a multiline comment. */
2020-02-10 08:01:04